<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>shark::IndexedIterator&lt; Iterator &gt; Class Template Reference</title>
<script type="text/javaScript" src="search/search.js"></script>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script>
<script id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/mathjax@3.0.1/es5/tex-mml-chtml.js"></script>
<script src="../../mlstyle.js"></script>
<link href="../css/besser.css" rel="stylesheet" type="text/css"/>
</head>
<!-- pretty cool: each body gets an id tag which is the basename of the web page  -->
<!--              and allows for page-specific CSS. this is client-side scripted, -->
<!--              so the id will not yet show up in the served source code -->
<script type="text/javascript">
    jQuery(document).ready(function () {
        var url = jQuery(location).attr('href');
        var pname = url.substr(url.lastIndexOf("/")+1, url.lastIndexOf(".")-url.lastIndexOf("/")-1);
        jQuery('#this_url').html('<strong>' + pname + '</strong>');
        jQuery('body').attr('id', pname);
    });
</script>
<body>
    <div id="shark_old">
        <div id="wrap">
            <div id="header">
                <div id="site-name"><a href="../../sphinx_pages/build/html/index.html">Shark machine learning library</a></div>
                <ul id="nav">
                    <li >
                        <a href="../../sphinx_pages/build/html/rest_sources/installation.html">Installation</a>
                    </li>
		    <li >
                        <a href="../../sphinx_pages/build/html/rest_sources/tutorials/tutorials.html">Tutorials</a>
                    </li>
		    <li >
                        <a href="../../sphinx_pages/build/html/rest_sources/benchmark.html">Benchmarks</a>
                    </li>
                    <li class="active">
                        <a href="classes.html">Documentation</a>
                        <ul>
                            <li class="first"></li>
                            <li><a href="../../sphinx_pages/build/html/rest_sources/quickref/quickref.html">Quick references</a></li>
                            <li><a href="classes.html">Class list</a></li>
                            <li class="last"><a href="group__shark__globals.html">Global functions</a></li>
                        </ul>
                    </li>
                </ul>
            </div>
        </div>
    </div>
<div id="doxywrapper">
<!--
    <div id="global_doxytitle">Doxygen<br>Documentation:</div>
-->
    <div id="navrow_wrapper">
<!-- Generated by Doxygen 1.9.8 -->
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceshark.html">shark</a></li><li class="navelem"><a class="el" href="classshark_1_1_indexed_iterator.html">IndexedIterator</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="classshark_1_1_indexed_iterator-members.html">List of all members</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#friends">Friends</a>  </div>
  <div class="headertitle"><div class="title">shark::IndexedIterator&lt; Iterator &gt; Class Template Reference</div></div>
</div><!--header-->
<div class="contents">

<p>creates an Indexed Iterator, an Iterator which also carries index information using <a class="el" href="classshark_1_1_indexed_iterator.html#addc567fdd49114d13a2084d2c197df33">index()</a>  
 <a href="classshark_1_1_indexed_iterator.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_iterators_8h_source.html">shark/Core/utility/Iterators.h</a>&gt;</code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for shark::IndexedIterator&lt; Iterator &gt;:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classshark_1_1_indexed_iterator__inherit__graph.png" border="0" usemap="#ashark_1_1_indexed_iterator_3_01_iterator_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="ashark_1_1_indexed_iterator_3_01_iterator_01_4_inherit__map" id="ashark_1_1_indexed_iterator_3_01_iterator_01_4_inherit__map">
<area shape="rect" title="creates an Indexed Iterator, an Iterator which also carries index information using index()" alt="" coords="284,35,432,76"/>
<area shape="rect" title=" " alt="" coords="5,5,236,106"/>
<area shape="poly" title=" " alt="" coords="251,53,283,53,283,58,251,58"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ae36af0bf7699c067d3b9a21e160b94c3" id="r_ae36af0bf7699c067d3b9a21e160b94c3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_indexed_iterator.html#ae36af0bf7699c067d3b9a21e160b94c3">IndexedIterator</a> ()</td></tr>
<tr class="separator:ae36af0bf7699c067d3b9a21e160b94c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a929e1426bfedfc5224f55e735b12cc2d" id="r_a929e1426bfedfc5224f55e735b12cc2d"><td class="memTemplParams" colspan="2">template&lt;class I &gt; </td></tr>
<tr class="memitem:a929e1426bfedfc5224f55e735b12cc2d"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classshark_1_1_indexed_iterator.html#a929e1426bfedfc5224f55e735b12cc2d">IndexedIterator</a> (<a class="el" href="classshark_1_1_indexed_iterator.html">IndexedIterator</a>&lt; I &gt; const &amp;iterator)</td></tr>
<tr class="memdesc:a929e1426bfedfc5224f55e735b12cc2d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy-Constructs this iterator from some other <a class="el" href="classshark_1_1_indexed_iterator.html" title="creates an Indexed Iterator, an Iterator which also carries index information using index()">IndexedIterator</a> convertible to this.  <br /></td></tr>
<tr class="separator:a929e1426bfedfc5224f55e735b12cc2d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6739a0cf9815492c1df78e7af5a34824" id="r_a6739a0cf9815492c1df78e7af5a34824"><td class="memTemplParams" colspan="2">template&lt;class IteratorT &gt; </td></tr>
<tr class="memitem:a6739a0cf9815492c1df78e7af5a34824"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classshark_1_1_indexed_iterator.html#a6739a0cf9815492c1df78e7af5a34824">IndexedIterator</a> (IteratorT const &amp;iterator, std::size_t startIndex)</td></tr>
<tr class="memdesc:a6739a0cf9815492c1df78e7af5a34824"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs the iterator from another iterator plus a starting index.  <br /></td></tr>
<tr class="separator:a6739a0cf9815492c1df78e7af5a34824"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:addc567fdd49114d13a2084d2c197df33" id="r_addc567fdd49114d13a2084d2c197df33"><td class="memItemLeft" align="right" valign="top">std::size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_indexed_iterator.html#addc567fdd49114d13a2084d2c197df33">index</a> () const</td></tr>
<tr class="separator:addc567fdd49114d13a2084d2c197df33"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:ad04e1f8c5114da431d0d97fb42329621" id="r_ad04e1f8c5114da431d0d97fb42329621"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_indexed_iterator.html#ad04e1f8c5114da431d0d97fb42329621">SHARK_ITERATOR_CORE_ACCESS</a></td></tr>
<tr class="separator:ad04e1f8c5114da431d0d97fb42329621"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;class Iterator&gt;<br />
class shark::IndexedIterator&lt; Iterator &gt;</div><p>creates an Indexed Iterator, an Iterator which also carries index information using <a class="el" href="classshark_1_1_indexed_iterator.html#addc567fdd49114d13a2084d2c197df33">index()</a> </p>
<p>The underlying Iterator must be a random access iterator </p>

<p class="definition">Definition at line <a class="el" href="_iterators_8h_source.html#l00046">46</a> of file <a class="el" href="_iterators_8h_source.html">Iterators.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ae36af0bf7699c067d3b9a21e160b94c3" name="ae36af0bf7699c067d3b9a21e160b94c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae36af0bf7699c067d3b9a21e160b94c3">&#9670;&#160;</a></span>IndexedIterator() <span class="overload">[1/3]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Iterator &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classshark_1_1_indexed_iterator.html">shark::IndexedIterator</a>&lt; Iterator &gt;::IndexedIterator </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="_iterators_8h_source.html#l00054">54</a> of file <a class="el" href="_iterators_8h_source.html">Iterators.h</a>.</p>

</div>
</div>
<a id="a929e1426bfedfc5224f55e735b12cc2d" name="a929e1426bfedfc5224f55e735b12cc2d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a929e1426bfedfc5224f55e735b12cc2d">&#9670;&#160;</a></span>IndexedIterator() <span class="overload">[2/3]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Iterator &gt; </div>
<div class="memtemplate">
template&lt;class I &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classshark_1_1_indexed_iterator.html">shark::IndexedIterator</a>&lt; Iterator &gt;::IndexedIterator </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classshark_1_1_indexed_iterator.html">IndexedIterator</a>&lt; I &gt; const &amp;&#160;</td>
          <td class="paramname"><em>iterator</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Copy-Constructs this iterator from some other <a class="el" href="classshark_1_1_indexed_iterator.html" title="creates an Indexed Iterator, an Iterator which also carries index information using index()">IndexedIterator</a> convertible to this. </p>

<p class="definition">Definition at line <a class="el" href="_iterators_8h_source.html#l00059">59</a> of file <a class="el" href="_iterators_8h_source.html">Iterators.h</a>.</p>

</div>
</div>
<a id="a6739a0cf9815492c1df78e7af5a34824" name="a6739a0cf9815492c1df78e7af5a34824"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6739a0cf9815492c1df78e7af5a34824">&#9670;&#160;</a></span>IndexedIterator() <span class="overload">[3/3]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Iterator &gt; </div>
<div class="memtemplate">
template&lt;class IteratorT &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classshark_1_1_indexed_iterator.html">shark::IndexedIterator</a>&lt; Iterator &gt;::IndexedIterator </td>
          <td>(</td>
          <td class="paramtype">IteratorT const &amp;&#160;</td>
          <td class="paramname"><em>iterator</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::size_t&#160;</td>
          <td class="paramname"><em>startIndex</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Constructs the iterator from another iterator plus a starting index. </p>

<p class="definition">Definition at line <a class="el" href="_iterators_8h_source.html#l00064">64</a> of file <a class="el" href="_iterators_8h_source.html">Iterators.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="addc567fdd49114d13a2084d2c197df33" name="addc567fdd49114d13a2084d2c197df33"></a>
<h2 class="memtitle"><span class="permalink"><a href="#addc567fdd49114d13a2084d2c197df33">&#9670;&#160;</a></span>index()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Iterator &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">std::size_t <a class="el" href="classshark_1_1_indexed_iterator.html">shark::IndexedIterator</a>&lt; Iterator &gt;::index </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="_iterators_8h_source.html#l00067">67</a> of file <a class="el" href="_iterators_8h_source.html">Iterators.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Friends And Related Symbol Documentation</h2>
<a id="ad04e1f8c5114da431d0d97fb42329621" name="ad04e1f8c5114da431d0d97fb42329621"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad04e1f8c5114da431d0d97fb42329621">&#9670;&#160;</a></span>SHARK_ITERATOR_CORE_ACCESS</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Iterator &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">friend class SHARK_ITERATOR_CORE_ACCESS</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="_iterators_8h_source.html#l00078">78</a> of file <a class="el" href="_iterators_8h_source.html">Iterators.h</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/shark/Core/utility/<a class="el" href="_iterators_8h_source.html">Iterators.h</a></li>
</ul>
</div><!-- contents -->
</div>
</body>
</html>
